---
title: "Get Chat Engagement"
api: "GET https://api-v2.opencopilot.so/backend/reports/{orgId}/chats/engagement"
description: "Retrieve chat engagement metrics for a specified period and organization"
---

This endpoint provides chat engagement metrics, including the total number of chats, the number of engaged chats, and the engagement rate.

## Authentication

<ParamField header="Authorization" type="string" required>
  Bearer token for authentication
</ParamField>

### Path Parameters

<ParamField path="orgId" type="string" required>
  The ID of the organization to filter the results
</ParamField>

### Query Parameters

<ParamField query="startDate" type="string" format="date">
  The start date for the report period (ISO 8601 format)
</ParamField>

<ParamField query="endDate" type="string" format="date">
  The end date for the report period (ISO 8601 format)
</ParamField>

<ParamField query="channel" type="string">
  The channel to filter the results (e.g., "web", "mobile")
</ParamField>

<ParamField query="status" type="number">
  The status of the chat sessions to include
</ParamField>

### Response

<ResponseField name="total_chats" type="number">
  The total number of chat sessions in the specified period
</ResponseField>

<ResponseField name="engaged_chats" type="number">
  The number of chat sessions where there was at least one message exchange
</ResponseField>

<ResponseField name="engagement_rate" type="number">
  The ratio of engaged chats to total chats, expressed as a decimal (0 to 1)
</ResponseField>

<RequestExample>

```bash Example Request
curl --location --request GET 'https://api-v2.opencopilot.so/backend/reports/chats/engagement?startDate=2023-01-01T00:00:00Z&endDate=2023-12-31T23:59:59Z&channel=web&status=1' \
--header 'Authorization: Bearer YOUR_API_KEY'
```

</RequestExample>

<ResponseExample>

```json Response
{
  "total_chats": 1000,
  "engaged_chats": 850,
  "engagement_rate": 0.85
}
```

</ResponseExample>